home *** CD-ROM | disk | FTP | other *** search
/ The X-Philes (2nd Revision) / The X-Philes Number 1 (1995).iso / xphiles / hp48hor1 / calenda1.doc < prev    next >
Text File  |  1995-03-31  |  5KB  |  125 lines
  1. ***************************************************************************** 
  2. *         DOCUMENTATION FILE FOR HP48SX CALENDAR DRAWING FUNCTIONS          * 
  3. *                              Version 1.02                                 * 
  4. *                                                                           * 
  5. *                   by Kevin Jessup  October 23rd, 1990                     * 
  6. ***************************************************************************** 
  7.  
  8. [The HORN1 disk contains Kevin's first version, which doesn't work.  This 
  9.  one works!  -jkh-] 
  10.  
  11. A thousand appologies.  I screwed up again!  There was still a bug in 
  12. the ALMDATE? routine that I said was fixed in version 1.01.  So much 
  13. for my software validation methods.  Let's try one more time!  Here 
  14. is version 1.02.  The ALMDATE? routine is the only difference between 
  15. this and previous versions. 
  16.  
  17. If you have successfully loaded the binary CALENDAR directory file, a 
  18. directory named "CALENDAR" should now be in your current working directory. 
  19. Verify the following... 
  20.  
  21.    Checksum:   # 14BA (hex) or # 5306 (decimal) 
  22.    Byte count: 2479 
  23.  
  24.    Note:       The checksum will change if the day, month or year global 
  25.                variables have been modified since you downloaded the 
  26.                directory! 
  27.  
  28.  
  29. Introduction 
  30. ------------ 
  31. These routines will display a calendar graphic for a specific year and month 
  32. on the 48SX display.  Functions are provided to move the calendar forward 
  33. or backwards in month or year increments.  Day  of week and leap year func- 
  34. tions are also provided. 
  35.  
  36. The CALENDAR directory should contain the following objects in the order 
  37. they appear below.  For ease of use, DO NOT re-order the directory. 
  38. Objects preceeded with an asterisk (*) are described in detail later.  All 
  39. other objects are subroutines used by the main functions and are NOT 
  40. described.  A listing of ALL objects is provided at the end of the 
  41. documentation. 
  42.  
  43. Name       Object type     Purpose 
  44. -------    -----------     -------------------------------------------------- 
  45. * CURR     program         Draws a calendar for the current month. 
  46. * <-Y      program         Draws a calendar for the previous year, same month. 
  47. * Y->      program         Draws a calendar for the next year, same month. 
  48. * <-M      program         Draws a calendar for the previous month, same year. 
  49. * M->      program         Draws a calendar for the next month, same year. 
  50. * PCAL     program         Prints the last calendar dislayed. 
  51. * CAL      program         Given specific month and year, draws the calendar. 
  52. * DOW      program         Returns current day of week string to stack. 
  53. * SDOW     program         Given a date, returns day of week string to stack. 
  54. * RDOW     program         Given a date, returns day of week number to stack. 
  55. * LPYR     program         Given a year, determines if it is a leap year. 
  56. * ALMDATE? program         Given a date, determines if any alarms are due. 
  57.   MOY      list            Months of the year. 
  58.   DIM      list            Number of days in the months. 
  59.   DOWL     list            Days of the week. 
  60.   GENC     program         Main calendar graphic generating function. 
  61.   FILLD    program         Adds days and alarm flags to the calendar graphic. 
  62.   MONTHBOX program         Draws the calendar graphic lines and days of week. 
  63.   CPSDT    program         Compress date and time. 
  64.   EXPDT    program         Expand date and time. 
  65.   JFIX     program         Adjust for date mode. 
  66.   day      real number 
  67.   year     real number 
  68.   month    real number 
  69.   PPAR     list            Plot parameters. 
  70.  
  71.  
  72. Detailed function descriptions 
  73. ------------------------------ 
  74.  
  75. CURR    Draws a calendar for the current month.  A graphic display of the 
  76.     month, year and appropriately positioned day numbers is generated. 
  77.     Days that have an alarm associated with them will contain a box 
  78.     to mark the alarm. 
  79.  
  80. <-Y    Same as CURR but backs up one year. 
  81.  
  82. Y->    Same as CURR but moves forward one year. 
  83.  
  84. <-M    Same as CURR but backs up one month. 
  85.  
  86. M->    Same as CURR but moves forward one month. 
  87.  
  88. PCAL    Prints the current contents of the PICT variable.  If some other 
  89.     program has not deleted PICT or modified it, the object printed 
  90.     should be the last calendar you displayed. 
  91.  
  92. CAL    Given a date on the stack in valid HP48SX date format (MM.DDYYYY or 
  93.     DD.MMYYYY) displays the calendar for the month as in CURR. 
  94.  
  95. DOW    Returns the current day of week text string to the stack. 
  96.  
  97. SDOW    Given a date as in CAL, returns the day of week text string to the 
  98.     stack. 
  99.  
  100. RDOW    Same as SDOW but returns a real number. 
  101.     Sunday = 0, Monday = 1,  ...  Saturday = 6. 
  102.  
  103. LPYR    Given a year on level 1, returns 1 if it is a leap year, else 0. 
  104.  
  105. ALMDATE? 
  106.     Given a date as in CAL, returns 1 if alarms are due on that date, 
  107.     else 0.  Always returns 0 if date input is less than the current 
  108.     date (Does not detect past-due alarms!). 
  109.  
  110.  
  111. Warranties and Support 
  112. ---------------------- 
  113. None provided.  Programs are supplied AS IS. 
  114.  
  115.  
  116. Shareware 
  117. --------- 
  118. Please support the HP48SX "shareware" concept by either contributing a few 
  119. bucks to the author (address below) or posting your own USEFUL programs 
  120. on the HP48SX BBS! 
  121.  
  122.                         Kevin Jessup 
  123.                         9118 N. 85th St. 
  124.                         Milwaukee, WI 53224 
  125.